Copies a source image to a destination buffer. More...

#include <kanzi/gfx/commands.hpp>

Inheritance diagram for kanzi::gfx::CopyImageToBufferCommand:

Public Member Functions
	CopyImageToBufferCommand ()
	Constructor.

Public Member Functions inherited from kanzi::gfx::BaseCommand
uint32_t	getSize () const
	Gets the command size in bytes.

uint8_t	getTag () const
	Gets the command tag.

CommandType	getType () const
	Gets the command type.

void	setTag (uint8_t tag)
	Sets the command tag.

Public Attributes
AspectMask	aspectMask
	The aspect mask.

BufferHandleGuard	destinationBuffer
	The destination buffer. Must have BufferUsageFlag::CopyDestination.

uint32_t	destinationImageHeight
	The destination height for 3D textures. Value 0 assumes the data is tightly packed according to source region.

uint32_t	destinationOffset
	The destination offset in bytes.

uint32_t	destinationRowLength
	The destination row length in pixels. Value 0 assumes the data is tightly packed according to source region.

ImageHandleGuard	sourceImage
	The source image. Must have ImageUsageFlag::CopySource.

box3u32	sourceRegion
	The source region. Defaults to the whole image.

ImageSubresource	sourceSubresource
	The source subresource.

Additional Inherited Members
Protected Member Functions inherited from kanzi::gfx::BaseCommand
	BaseCommand (CommandType t, uint32_t s)
	Constructor.

	BaseCommand (const BaseCommand &other)
	Copy Constructor.

BaseCommand &	operator= (const BaseCommand &other)
	Assignment operator.

Detailed Description

Copies a source image to a destination buffer.

Since: Kanzi 4.0.0

Constructor & Destructor Documentation

◆ CopyImageToBufferCommand()

kanzi::gfx::CopyImageToBufferCommand::CopyImageToBufferCommand ( )

inline

Constructor.

Member Data Documentation

◆ sourceImage

ImageHandleGuard kanzi::gfx::CopyImageToBufferCommand::sourceImage

The source image. Must have ImageUsageFlag::CopySource.

◆ sourceRegion

box3u32 kanzi::gfx::CopyImageToBufferCommand::sourceRegion

The source region. Defaults to the whole image.

◆ sourceSubresource

ImageSubresource kanzi::gfx::CopyImageToBufferCommand::sourceSubresource

The source subresource.

◆ destinationBuffer

BufferHandleGuard kanzi::gfx::CopyImageToBufferCommand::destinationBuffer

The destination buffer. Must have BufferUsageFlag::CopyDestination.

◆ destinationOffset

uint32_t kanzi::gfx::CopyImageToBufferCommand::destinationOffset

The destination offset in bytes.

◆ destinationRowLength

uint32_t kanzi::gfx::CopyImageToBufferCommand::destinationRowLength

The destination row length in pixels. Value 0 assumes the data is tightly packed according to source region.

◆ destinationImageHeight

uint32_t kanzi::gfx::CopyImageToBufferCommand::destinationImageHeight

The destination height for 3D textures. Value 0 assumes the data is tightly packed according to source region.

◆ aspectMask

AspectMask kanzi::gfx::CopyImageToBufferCommand::aspectMask

The aspect mask.

The documentation for this struct was generated from the following file:

kanzi/gfx/commands.hpp

Public Member Functions

Public Attributes

Additional Inherited Members